home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / comm / bbs / maxsdoors.lha / FileGen2.5.lha / FileGen.Doc < prev    next >
Text File  |  1991-09-15  |  9KB  |  226 lines
  1.                               FileGen V2.5
  2.                        ==========================
  3.                        (C) 1991 by Edward Lawford
  4.                        ==========================
  5.  
  6.       This utility and it's source code is placed in public domain
  7.                     under the following conditions:
  8.  
  9.         (1).    The source code, executable and documents are left
  10.                 in the archive and not altered in any way for distribution.
  11.  
  12.         (2).    The source code may be altered in any way aslong as it
  13.                 isn't altered for use with any BBS program other than MaxsBBS.
  14.         (3).    My name and credits is left intact in the archive.
  15.  
  16.  
  17.                  Other than that, I hope it is useful!
  18.  
  19.  
  20. THE DOCS:
  21. =========
  22.  
  23. This programs purpose in computer life is to generate a readable text
  24. file from MaxsBBS's File.Data file for people to download and browse
  25. through it.
  26.  
  27. USAGE:
  28. ======
  29.  
  30. Well, FileGen has changed quite a bit in apperance since 1.2a... it also
  31. has a minor bug fix.
  32.  
  33. FileGen no longer accepts command line switches. It will only accept
  34. section # exclusions as before. To exclude any section(s) from the list,
  35. just place the sections names as the args for the program. E.g:
  36.  
  37.     FileGen 28 35 36
  38.  
  39. This would exclude sections 28, 35 and 36 from the file list. You can
  40. use this feature to generate multiple file lists for different
  41. "sections" of your BBS if you use a clever batch file.
  42.  
  43. If anyone had seen V1.x of FileGen, you would know that you used command
  44. line switches to sort/lharc etc... Well now it is as easy as loading up
  45. FileGenConfig and setting the settings there. They are fairly straight
  46. forward. The textfile name is the name of the file that contains no ANSI
  47. codes in it. It is also the file that is placed into an lharc if you
  48. want one. The ANSI output filename is the same as the Textfile output
  49. name but has ANSI codes to make things stand out. This textfile could be
  50. used on the BBS itself.
  51.  
  52. The switch for Lharc is so you can instruct FileGen to lharc your file
  53. list after generation. This can be handy as you can then supply it to
  54. users for downloading.
  55.  
  56. The switch for sort is to tell FileGen that you do or do not want it to
  57. sort the files into ascending alphabetical when generating the list.
  58. This is oppsed to the natural cronological sort.
  59.  
  60. The switch for header is to enable you to add a textfile header of any
  61. type you choose, to the top of the file list. You can design the header
  62. in any way you like but ANSI is not recommended. It can also be called
  63. whatever you like.
  64.  
  65. The switch for pause is whether you want FileGen to add a %Z to the end
  66. of .ansi file. Since the ANSI file was meant for display on the BBS, it
  67. will force a page pause at the end of the list.
  68.  
  69. The archive cmd string gadget is used to totally customize the meathod
  70. of archiving you use... This means that you can use Arc or Zip instead
  71. of lharc. The only drawback is that output from Lharc now has to be to
  72. the Stdout (CLI) Until I can figure out how to tell it to do otherwise
  73. without a >CON: command.
  74.  
  75. The TopDL gadget and TopDl name string gadget allow you to generate a
  76. list of the 10 most downloaded files on your BBS. The list generated
  77. uses heavy ANSI commands and so is really only fit for display on your
  78. BBS but it looks great! It is also quite interesting and useful for
  79. users.
  80.  
  81. Once you have finished configuring it, just click on the Save gadget and
  82. then the Close gadget in the titlebar.
  83.  
  84. CHANGE SINCE V1.0:
  85. =================
  86.  
  87. - The program has been changed a bit since V1.0 to include Lharcing from
  88.   the command line which saves running a batch file to do it for you.
  89. - I have changed the way it checks the files to make the program
  90.   execution time ALOT faster. It now takes around 25% of the time it
  91.   used to take to list the same amount of files and there is hardly any
  92.   disk thrashing.
  93.  
  94. CHANGES SINCE V1.1:
  95. ===================
  96.  
  97. - Main change, added the file sort routine to sort the files. This has
  98.   come about because I tougt myself how to do a bubble sort in C!.
  99. * Bug fix:  I realized that lharc (Lz V1.01) wouldn't add a file that
  100.   already existed into an existing archive so I had to delete the file
  101.   before lharcing.
  102.  
  103. CHANGES SINCE V1.2:
  104. ===================
  105.  
  106. - The ability to specify the path and the output name of the lharc file.
  107.   (At request from otto.)
  108.  
  109. CHANGES SINCE 1.2a:
  110. ===================
  111.  
  112. - MAJOR cosmetic overhaul.
  113. - FileGen now uses an Intuition window with intuition text and intuition
  114.   gadgets for it's output. This means that the display is alot clearer,
  115.   alot FASTER and looks ALOT better. The list should generate much
  116.   faster now because IntuiText dosn't have so much overhead as CLI output
  117.   does.
  118. - The addition of a Configuration file called S:FileGen.config and a
  119.   complete program to configure FileGen... Just like alot of IBM programs
  120.   do.
  121. * Bug Fix:  A rare one - FileGen wasn't scanning section 99, It just
  122.   skipped it. Hope it's fixed and thanx otto (again :-)).
  123.  
  124. CHANGES SINCE 2.0d:
  125. ===================
  126.  
  127. - Added an "Archive cmd string" to the configure window. This allows you
  128.   to totally customize the method of archiving you use and the name of
  129.   your archiver.
  130. - A few minor things. I have forgotten :-)
  131.  
  132. CHANGES SINCE V2.2:
  133. ===================
  134.  
  135. - Added a headerfile support. You can now add a header from within
  136.   FileGen instead of using a complex batch file. It inserts the header
  137.   at the top of EVERYTHING in both ANSI and ASCII textfiles. This can
  138.   be quite a good way for people to identify your BBS and can also be a
  139.   good add. The file can be as long as you like.
  140. - FileGen now inserts the full date and time after the copyright notice
  141.   so people can find out how current the filelist. Again, this gets rid of
  142.   the need to use a complicated batchfile and temporary files.
  143. - Took some of the stupid bitmaps out of the config file to save chip
  144.   mem and add room. It should also make the file size alot smaller. I had
  145.   to do this to make room for the 2 extra gadgets.
  146. - Small cosmetic change:  The config program now ghosts the Lharc
  147.   filename and the Archive command gadgets when Archive is de-selected. It
  148.   also ghosts the header filename when Header is de-selected. This is just
  149.   there to remind you that they arn't active.
  150.  
  151. - Because this is what I expect to be the final version, the source code
  152.   is included in the distribution archive. See "Source.doc" for more
  153.   info.
  154.  
  155. CHANGES SINCE V2.3:
  156. ===================
  157.  
  158. * Bug fixed:  My stupid mistake. This was a major bug. Memory wasn't getting
  159.   free'd everytime the program exited. This because I was doing Exit()
  160.   instead of exit(). The difference being that the first is the AmigaDOS exit
  161.   which doesn't de-allocate all malloc() and calloc() (Which is what I
  162.   use). Fixed now. (Changing the case of that 'e' was pretty strenuous
  163.   work! I almost threw in the towel :-))
  164. - Changed sort routine:  I now use my OWN sort routine although I'm sure
  165.   someone has thought of it before. If you would like the routine, give us
  166.   a buzz.
  167. - Changed the format of the file listing.. Much improved. It now goes
  168.   like this:
  169.  
  170. FileName             Description
  171.                      Date             Size   Dloads
  172.  
  173. CHANGE FOR V2.5:
  174. ================
  175.  
  176. * BUG FIXED! Yes folks, it's fixed now. The date at the beggining of
  177.   the list isn't 100 billion, it's now correct. Sorry bout this one.
  178.   The whole listing was actually a mess and I had to fix it up. The
  179.   title of each file area is now much nicer and the whole list looks a
  180.   whole heap better! I hope you like it.
  181.  
  182. - Changed the listing format of the list (Again!) It now goes something
  183.   like this:
  184.  
  185. FileName             Description
  186.                         Date         Size
  187.  
  188.   You are supposed to use DownTrac to display the downloads as it looks
  189.   alot more attractive.
  190.  
  191. - Added TopDL listing. This is quite useful and I have been meaning to
  192.   put it in for a while. Naturally, files from excluded sections won't
  193.   be added to the list.
  194.  
  195.     This version is basically a big cleanup and I hope that all the
  196.     bugs have been removed. Please don't hesitate to drop me a line if
  197.     you find any bugs or have any suggestions!
  198.  
  199.  
  200. BUG REPORTS:
  201. ============
  202.  
  203. If you have any bug reports/complaints/suggestions for any of my MaxsBBS
  204. utilties, please don't hesitate to drop me a line:
  205.  
  206.         Edward Lawford
  207.         Fire & Stone AMIGA BBS - (02) 960-3621, Sydney, Australia.
  208.  
  209.  
  210. NOTE:
  211. =====
  212.  
  213. After 1 year of thinking about it, my BBS is now online at the above
  214. address. Give it a call. I stock the latest MaxsBBS utilities written by
  215. me and other people. Instead of going through MaxsBBS, you can nows
  216. contact me directly.
  217.  
  218. FINAL NOTE:
  219. \=========/
  220.  
  221. I hope you like this version. I think it has come to closing stage now
  222. and is a finished product. If I get anymore ideas, I will implement them
  223. and distribute.  I Hope you like this version! And bug reports are most
  224. definatly welcome. (Although not liked :-))
  225.  
  226.